Skip to main content

Sync Templates

Overview

Sync Templates enable the grouping of solutions for synchronizing two work systems. A Sync Template contains:

  1. Entity Pairs to be Synchronized: The specific entities from each system that will be kept in sync.
  2. Entity Fields to be Synchronized: The individual fields within each entity pair, including any necessary transformations, scripts, or plugins for deployment.
  3. Map Options: Configuration options such as logging into a field in another system, conflict resolution strategies, and more as described in the mapping options section.

SyncNow Operators can:

  1. Create a Template: Define a new template and add it to the template repository for reuse.
  2. Export a Template: Save the template as a .snw file for easy distribution and backup.
  3. Sign the Template: Use a certificate to sign the template, ensuring its integrity and authenticity.
  4. Set a Template Version: Assign a version to the template to manage updates and maintain version control.

This feature allows for efficient reuse and management of synchronization mappings across multiple projects and deployments.

Template Repository

The Template Repository stores all the templates used in SyncNow deployment. For each Sync Template, the following information is presented:

  1. Verification and Signing: Indicates if the template is verified and signed with a valid certificate.

    We recommend using only templates created or signed with certificates from known publishers.
  2. Template Title: The name of the template.
  3. Previous Versions: Metadata of previous versions of the template.
  4. Publishing Date: The date the template was first published.
  5. Updated Date: The date of the most recent update to the template.
  6. Author Name: The name of the person who created the template.
  7. Work Systems: The systems for which the template has defined mappings.

Work System Template

This repository ensures that all synchronization templates are easily accessible, verifiable, and up-to-date, facilitating efficient and secure synchronization processes.

Certainly! Here is a revised version of your instructions for uploading a Sync template:

Upload Sync Template

This guide explains how to upload a .snw template file.

  1. Navigate to the Templates page: Go to the Templates page in the SyncNow interface.
  2. Upload a New Version: In this example, we will upload a new version (v1.0.1) of an existing template.
  3. Press the Upload Template button: Click on the "Upload Template" button. Capture
  4. Find the .snw file: Locate and select the .snw file in your file system.
  5. Optionally Upload a Certificate: You can optionally upload a certificate (.p12 or .pfx file) and enter the password for the certificate's private key. The template will be signed with the private key. Only the certificate's public key and signature will be saved in the database. The private key and password will not be stored.
  6. Press the Save button: Click "Save" to complete the upload.
  7. Template Uploaded: A new template has been successfully uploaded.

Create a Sync Template

This guide explains how to create a Sync template from an existing Sync Process mapping.

  1. Navigate to the Processes or Global Mappings page: Start by going to the Processes or Global Mappings page in the SyncNow interface.
  2. Press the Mapping Entities button: Click on the "Mapping Entities" button.
  3. Press the Create Template button: Select the "Create Template" button. Sync Processes
  4. Input Details in the Create Template Dialog:
    • Image (optional): Upload an image if desired.
    • Unique Name: Provide a unique name for the template.
    • Version: Specify the version of the template.
    • Author: Enter the author’s name.
    • Description: Add a description of the template.
    • Upload a Certificate (optional): Optionally, upload a certificate (.p12 or .pfx file) and enter the password for the certificate's private key. The template will be signed with the private key. Only the certificate's public key and signature will be saved in the database. The private key and password will not be stored.
  5. Press the Save button: Click "Save" to create the template. Create Template
  6. Go to the Templates page: Navigate to the Templates page.
  7. New Template Added: The new template has been successfully added. Templates

Here is a revised version of your instructions for Sync template security:

Sync Template Security

Sync Templates can contain code and plugins; therefore, it is highly recommended to ensure they come from a trusted source. SyncNow provides information about certificate verification on the template repository screen to help verify the source.

Security Settings

SyncNow Operators can configure settings to allow only verified certificates (default) and to decide whether to approve self-signed certificates.

configuring security settings:

  1. Navigate to Settings: Go to the "Settings" menu.
  2. Select App Instance: Choose the "App Instance" option.
  3. Set Security Settings: Adjust the security settings as needed to control the use of verified and self-signed certificates.

Recommendation: We recommend not allowing self-signed certificates in production environments and permitting only verified certificates.